/****************************************************************************
**
** Copyright (C) 2019 The Qt Company Ltd.
** Contact: https://www.qt.io/licensing/
**
** This file is part of the QtWebEngine module of the Qt Toolkit.
**
** $QT_BEGIN_LICENSE:LGPL$
** Commercial License Usage
** Licensees holding valid commercial Qt licenses may use this file in
** accordance with the commercial license agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and The Qt Company. For licensing terms
** and conditions see https://www.qt.io/terms-conditions. For further
** information use the contact form at https://www.qt.io/contact-us.
**
** GNU Lesser General Public License Usage
** Alternatively, this file may be used under the terms of the GNU Lesser
** General Public License version 3 as published by the Free Software
** Foundation and appearing in the file LICENSE.LGPL3 included in the
** packaging of this file. Please review the following information to
** ensure the GNU Lesser General Public License version 3 requirements
** will be met: https://www.gnu.org/licenses/lgpl-3.0.html.
**
** GNU General Public License Usage
** Alternatively, this file may be used under the terms of the GNU
** General Public License version 2.0 or (at your option) the GNU General
** Public license version 3 or any later version approved by the KDE Free
** Qt Foundation. The licenses are as published by the Free Software
** Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3
** included in the packaging of this file. Please review the following
** information to ensure the GNU General Public License requirements will
** be met: https://www.gnu.org/licenses/gpl-2.0.html and
** https://www.gnu.org/licenses/gpl-3.0.html.
**
** $QT_END_LICENSE$
**
****************************************************************************/

#ifndef DISPLAY_FRAME_SINK_H
#define DISPLAY_FRAME_SINK_H

#include "display_consumer.h"
#include "display_producer.h"

#include "base/memory/ref_counted.h"
#include "base/memory/scoped_refptr.h"
#include "components/viz/common/surfaces/frame_sink_id.h"

#include <QMutex>

namespace QtWebEngineCore {

// Connects a DisplayConsumer with a DisplayProducer.
class DisplayFrameSink final : public base::RefCountedThreadSafe<DisplayFrameSink>
{
public:
    static scoped_refptr<DisplayFrameSink> findOrCreate(viz::FrameSinkId frameSinkId);
    DisplayFrameSink(viz::FrameSinkId frameSinkId);
    ~DisplayFrameSink();
    void connect(DisplayConsumer *consumer);
    void connect(DisplayProducer *producer);
    void disconnect(DisplayConsumer *consumer);
    void disconnect(DisplayProducer *producer);
    void scheduleUpdate();
    QSGNode *updatePaintNode(QSGNode *oldNode, RenderWidgetHostViewQtDelegate *delegate);

private:
    const viz::FrameSinkId m_frameSinkId;
    mutable QMutex m_mutex;
    DisplayProducer *m_producer = nullptr;
    DisplayConsumer *m_consumer = nullptr;
};

} // namespace QtWebEngineCore

#endif // !DISPLAY_FRAME_SINK_H
